home *** CD-ROM | disk | FTP | other *** search
/ Monster Media 1996 #15 / Monster Media Number 15 (Monster Media)(July 1996).ISO / internet / auhtml12.zip / AUTOHTML.DOC next >
Text File  |  1996-06-21  |  5KB  |  149 lines
  1.                                AUTOHTML
  2.  
  3.                               Version 1.1
  4.  
  5.  
  6.  
  7. Overview:
  8.  
  9. AUTOHTML creates a multi-page web site from text source files in the 
  10. current directory. The first page is always called TOC.HTML and is a 
  11. table of contents linking to the other pages. 
  12.  
  13. A page is created for each source file. If the defaults are selected, 
  14. a separate table of contents file will be created for each page, with 
  15. the name TOCxxxxx.HTM where xxxxx is the last five characters of the 
  16. source file name.
  17.  
  18. The title for the first page is received from the command line as a 
  19. parameter supplied to AUTOHTML.EXE. Enclose this text within speech 
  20. marks, or only the first word will be picked up! Each entry in the 
  21. first page (TOC.HTML) is derived from a single text line in a file 
  22. with the same name as the source file, but with the extension .TIT 
  23. (short for title). If a TIT file can not be located in the current 
  24. directory, the source file name is used. This title is also used to 
  25. head the source web page and any table of contents page for that 
  26. source file. 
  27.  
  28. Links are automaticaly created whenever a word refers to another item 
  29. heading in any of the source pages.
  30.  
  31. Source Files:
  32.  
  33. Source files follow the KNB format; Simply these are comprised of an 
  34. item heading line prefixed by an asterisk, thus: 
  35.  
  36. *This is an item heading
  37.  
  38. followed by any number of lines of text which comprise that item's 
  39. data.
  40.  
  41. To force a link to a multiple word heading, replace spaces with under 
  42. bars (_) within the item data, for example:
  43.  
  44. This example will link with Greater_London.
  45.  
  46.  
  47.  
  48. Command Line:
  49.  
  50.         AUTOHTML "Title For First Page"
  51.  
  52.  
  53. Automatic Links:
  54.  
  55. Automatic links will only ever be made to the first source file, in 
  56. alphabetical order, containing a reference to the item. You can force 
  57. other files to be linked first by so naming them as to be 
  58. alphabetically earlier. Eg; a file 'AAA.TXT' will be scanned before a 
  59. file called 'BAA.TXT'.
  60.  
  61. Limitations:
  62.  
  63. AUTOHTML will not create graphical systems. It is designed to carry 
  64. out the donkey work of linking multiple machine-readable text files 
  65. into a fully linked web site. If you want in-line graphics, forms, 
  66. links to other URLs and so on then you will have to add these your 
  67. self.
  68.  
  69.  
  70. AUTOHTML.INI:
  71.  
  72. AUTOHTML acceses a configuration file (autohtml.ini) in the directory 
  73. where autohtml.exe resides. This configuration file may be amended to 
  74. change the format of the created web site.
  75.  
  76. [preferences]
  77. separate table of contents=yes  (Table of contents separate to main 
  78.                                  data)
  79. main title font=1               (Font 1-6 for main title)
  80. sub title font=2                (Font 1-6 for subsequent title lines)
  81. toc font=3                      (Font to display table of contents 
  82.                                  entries)
  83. source=knb                      (Source file extension)
  84.  
  85. [item]
  86. title font=2                    (Font 1-6 for item titles)
  87. data font=4                     (Font 1-6 to display item data)
  88. title italic=yes                (Item titles Italic yes or no)
  89. title bold=yes                  (Item titles Bold yes or no)
  90.  
  91. [ignore]
  92. ; Any words in this section will not be linked
  93. A
  94. IN
  95. OF
  96. THE
  97.  
  98. Compatability:
  99.  
  100. AUTOHTML has been tested with Mosaic and Netscape.
  101.  
  102.  
  103. Frequently Asked Questions:
  104.  
  105. Q. I only have one source file, autohtml creates three HTML files. How do 
  106.    I get around this?
  107.  
  108. A. Autohtml always creates a primary table of contents HTML filed 
  109.    called TOC.HTM. This provides a link to all the source files. If 
  110.    you only have one source file, then you can delete the TOC.HTM 
  111.    file. If you have separate table of contents=yes set in the 
  112.    autohtml.ini configuration file, then two HTML files will be 
  113.    created for each source file. The name of one file will commence 
  114.    TOC and this is the table of contents for the other data file. 
  115.    Rename this table of contents file to TOC.HTM and your web site is 
  116.    done.
  117.  
  118. Q. Autohtml doesn't create any HTML files. What's wrong?
  119.  
  120. A. Autohtml searches the current directory for files with an extension 
  121.    matching the source= setting in the configuration file 
  122.    autohtml.ini. Probably you have an incorrect extension set in the 
  123.    configuration file. Remember, the extension in the source= line 
  124.    does not include a period, eg:
  125.  
  126.                 source=knb
  127.  
  128.  
  129.  
  130. Q. When I try to view the HTML files in Mosaic, Mosaic crashes. Help!
  131.  
  132. A. Mosaic is a rather fragile HTML viewer. Try splitting the source 
  133.    files down into more smaller files. 
  134.  
  135.  
  136.  
  137.  
  138. (c)1996 Servile Software
  139.  
  140. Servile Software
  141. 5 Longcroft Close
  142. Basingstoke
  143. Hampshire
  144. RG21 8XG
  145.  
  146. WWW     http://www.pins.co.uk/upages/probertm
  147. EMAIL   probertm@pins.co.uk
  148.  
  149.